home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / slqwikbo.zip / SLQWIK.DOC < prev    next >
Text File  |  1992-01-02  |  14KB  |  533 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                 SLQWiK 1.00
  16.  
  17.                 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  18.  
  19.                Created with the Searchlight Programmer's Library
  20.                Portions Copyright (c) 1991 Searchlight Software
  21.  
  22.                         New Files List by Kevin Bass
  23.                      Copyright (c) 1991 BiBass Software
  24.  
  25.                      Designed & Written by Jack Ridgway
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.                                   Page 1
  58.  
  59.         SLQWiK 1.00 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.    CONTENTS                                                          Page
  67.  
  68.      Disclaimer .....................................................  3
  69.  
  70.      Shareware Agreement ............................................  3
  71.  
  72.      What Does SLQWiK Do? ...........................................  4
  73.  
  74.      Configuration ..................................................  4
  75.  
  76.      SLQSetup .......................................................  6
  77.  
  78.      How To Run SLQWiK ..............................................  8
  79.  
  80.      Local Use ......................................................  8
  81.  
  82.      Registration ...................................................  8
  83.  
  84.      Support - Bug Reports ..........................................  9
  85.  
  86.      Acknowledgements ...............................................  9
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.                                   Page 2
  117.  
  118.         SLQWiK 1.00 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.    DISCLAIMER
  126.  
  127.      Users of SLQWiK must accept this disclaimer of warranty:
  128.      "SLQWiK is supplied as is.  The author disclaims all
  129.      warranties, expressed or implied, including, without limitation,
  130.      the warranties of merchantability and of fitness for any purpose.
  131.      The author assumes no liability for damages, direct or conse-
  132.      quential, which may result from the use of SLQWiK."
  133.  
  134.  
  135.    SHAREWARE AGREEMENT
  136.  
  137.      SLQWiK is a "shareware program" and is provided at no charge
  138.      to the user for evaluation.  Feel free to share it with your
  139.      friends, but please do not give it away altered or as part of
  140.      another system.  The essence of "user-supported" software is to
  141.      provide personal computer users with quality software without
  142.      high prices, and yet to provide incentive for programmers to
  143.      continue to develop new products.  If you find this program
  144.      useful and find that you are using it and continue to use it
  145.      after a reasonable trial period of forty-five days, then you must
  146.      register it.  The registration fee will license one copy for use
  147.      on any one computer at any one time.  You must treat this software
  148.      just like a book.  An example is that this software may be used by
  149.      any number of people and may be freely moved from one computer
  150.      location to another, so long as there is no possibility of it
  151.      being used at one location while it's being used at another.  Just
  152.      as a book cannot be read by two different persons at the same time.
  153.  
  154.      Commercial users of SLQWiK must register and pay for their copies
  155.      of SLQWiK within forty-five days of first use or their license is
  156.      withdrawn.  A BBS operated for profit IS a commercial environment;
  157.      however, a subscription system not operated for profit is not
  158.      considered a commercial environment in relation to this agreement.
  159.      Site-License arrangements may be arranged by contacting A.B.S.
  160.  
  161.      Anyone distributing SLQWiK for any kind of remuneration must
  162.      first contact A.B.S. at the address listed below for authorization.
  163.      This authorization will be automatically granted to distributors
  164.      recognized by the (ASP) as adhering to its guidelines for shareware
  165.      distributors, and such distributors may begin offering SLQWiK
  166.      immediately; however, A.B.S. must still be advised so that the
  167.      distributor can be kept up-to-date with the latest version of
  168.      SLQWiK.
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.                                   Page 3
  176.  
  177.         SLQWiK 1.00 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.    WHAT DOES SLQWiK DO?
  185.  
  186.      SLQWiK is the complete offline mail door for Searchlight.  It
  187.      currently supports QWiK and Text packets, other types will be 
  188.      added in the future.
  189.  
  190.      SLQWiK allows users to download their new messages and read/reply
  191.      offline, using almost any .QWK reader.  There are MANY .QWK readers
  192.      available, including readers for operating systems other than
  193.      MS-DOS.
  194.  
  195.      SLQWiK creates .QWK packets from the SL message bases, and reads in
  196.      .REP packets.  It follows the .QWK standards as designed by Mark
  197.      'Sparky' Herring.  It can optionally include welcome, news, and
  198.      goodbye screens designed by the SysOp.  SL_QWK supports both old
  199.      style and new style command messages.
  200.  
  201.      In Text mode, SLQWiK allows users to download their new messages in
  202.      a text file, no offline replies are possible.
  203.  
  204.      An optional new files listing can be downloaded with either format.
  205.  
  206.      Packets are downloaded and uploaded using internal protocols -
  207.      Xmodem (all 'standard' variants), Ymodem (128 or 1024 byte blocks),
  208.      Ymodem-G (send-only), and Zmodem.
  209.  
  210.      SLQWiK is designed for speed.  It is written in Pascal and
  211.      Assembler.  As many operations as possible are performed in RAM to
  212.      import & export messages as quickly as possible.
  213.  
  214.  
  215.    CONFIGURATION
  216.  
  217.      SLQWiK should run on any system running MS-DOS 3.3 or higher
  218.      with at least 384K free RAM.  The overlay version, SLQWiKO.EXE
  219.      will run in under 256K, and should be used in tight memory
  220.      situations.  SLQWiKO.EXE will use EMS for faster overlay loading
  221.      if it is available.  SLQWiK.EXE is somewhat faster than SLQWiKO.EXE,
  222.      and considerably faster if no EMS is available.
  223.  
  224.      SLQWiK is multi-tasker aware.  It will write to the virtual screen
  225.      if a supported multi-tasker is detected, and it will give up time
  226.      slices while waiting for user input.
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.                                   Page 4
  235.  
  236.         SLQWiK 1.00 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.      SLQWiK (as well as most of my programs) requires an environment
  244.      variable to function properly.  This environment variable is also
  245.      used by other programs (including some by Searchlight Software).
  246.      It is SLBBS=[path to config.sl2 for this node].  This makes multinode
  247.      usage easy.
  248.  
  249.      If your node 1 config.sl2 is in D:\BBS1 then you would put
  250.      SET SLBBS=D:\BBS1 in your batch file that runs that node.
  251.      IMPORTANT - for multinode systems, you must have a separate
  252.      SLBBS environment variable for each node.  It should be set in
  253.      the batch file that runs that node!  For single node systems,
  254.      you may put it in your autoexec.bat.
  255.  
  256.      Place SLQWiK into it's own directory, and place all of its files
  257.      there.  If it can't find its files, it will abort.  SLQWiK will
  258.      also look for PKZIP.EXE in your path.
  259.  
  260.      Run SLQSETUP.EXE.  This will write the default configuration files
  261.      that SLQWiK needs to run.  You can then customize the configuration
  262.      for your BBS.  Read the SLQSETUP section for more information.
  263.  
  264.      The User defaults are - XModem protocol, No New Files List, QWiK
  265.      Packet Type, Update Last Read Pointers, & Don't Download Messages
  266.      FROM you.  The user may configure the options via the C-onfigure
  267.      command in the door.  The user's configuration is written to a file
  268.      once the user has changed the defaults, and are loaded whenever the
  269.      user enters SLQWiK.
  270.  
  271.      SLQWiK uses PKZIP to archive the QWK mail packets.  Unarchiving
  272.      and file transfer protocols are internal.
  273.  
  274.  
  275.      If you're running multi-node, you can make sure that the correct
  276.      config.sl2 file is loaded by running SLQWiK from a batch file
  277.      similar to this:
  278.  
  279.      SLQWIK.BAT
  280.      echo off
  281.      set slbbs=[path to config.sl2 for this node]
  282.      slqwik
  283.  
  284.  
  285.      For more information on how SLQWiK works, see the SLQUSER.DOC.
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.                                   Page 5
  293.  
  294.  
  295.         SLQWiK 1.00 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.    SLQSETUP
  303.  
  304.      SLQSetup is a menu driven setup program for SLQWiK.
  305.  
  306.      Hit F1 while editing for a help screen of editor commands.
  307.  
  308.  
  309.      Below is an outline describing each option:
  310.  
  311.      Configure - General Configuration Options
  312.  
  313.  
  314.        BBS Info - General BBS Information
  315.  
  316.  
  317.          BBSID - 1-6 letters, used for the QWK/REP filename
  318.  
  319.          SysOp Name - Your name, must be the same as registered
  320.  
  321.          City, State, Country - BBS City, State, Country
  322.                                 All are optional
  323.  
  324.          BBS Phone # - BBS Phone Number
  325.  
  326.          Rename SysOp - 'Y' renames 'SYSOP' to the above SysOp Name
  327.                         on export and renames the above SysOp Name
  328.                         to 'SYSOP' on import
  329.  
  330.          Strip Tear Lines - 'Y' causes all occurences of a tear line
  331.                             ('---') in a message to be deleted
  332.  
  333.          Disable Tag Line - Disables the SLQWiK Tag Line at the bottom
  334.                             of all imported messages - for registered
  335.                             versions only
  336.  
  337.          Enable Swapping - Enable swapping for external modules (PKZIP,
  338.                            DOS Shell, etc.)
  339.  
  340.          Use EMS/XMS - Use EMS or XMS for swapping
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.                                   Page 6
  353.  
  354.         SLQWiK 1.00 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.        File Paths - Path Names for files
  362.  
  363.  
  364.          Local Download Directory - Directory where .QWK packets will be
  365.                                     placed during a local download
  366.  
  367.          Local Upload Directory - Directory where .REP packets will be
  368.                                   read in during a local upload
  369.  
  370.          Path for Swapping to Disk - Directory where the swap file will be
  371.                                      written if swapping to disk
  372.  
  373.  
  374.        Maximum Messages - Maximum Messages Settings by Baud Rate
  375.  
  376.  
  377.          Max Msgs Subboard - Maximum Number of Messages that can be
  378.                              exported on each Subboard
  379.  
  380.          Max Msgs Total - Total Maximum Number of Messages that can be
  381.                           exported
  382.  
  383.          User Override - 'Y' overrides the user's setting if they specify
  384.                          more than the Max Subboard or Max Total
  385.  
  386.          Active - 'N' locks out that baud rate from using the door
  387.  
  388.  
  389.        System Shell - Shell to DOS
  390.  
  391.  
  392.      Register - Registration Information
  393.  
  394.  
  395.        How to Register - Registration 'blurb' screen
  396.  
  397.        Enter Reg. Number - Enter Your Registration Info
  398.  
  399.        Print Reg. From - Print out the Registration form to PRN
  400.  
  401.  
  402.      Edit Users - User Configuration Editor
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.                                   Page 7
  412.  
  413.         SLQWiK 1.00 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.    HOW TO RUN SLQWiK
  421.   
  422.      SLQWiK will be run from your doors.def file.  The entry is:
  423.  
  424.      2;0;0;[min access];[door name];[path to SLQWiK];slqwik.exe
  425.  
  426.      for example:
  427.  
  428.      2;0;0;5;SLQWiK Offline Mail Door;d:\doors\slqwik;slqwik.exe
  429.  
  430.      Anyone with access level >= 5 can access the door, and the door is
  431.      located in d:\doors\slqwik
  432.  
  433.  
  434.    LOCAL USE
  435.  
  436.      To upload a packet locally, copy the .REP packet into the Local
  437.      .REP directory, as defined in SLQSETUP, and run the door (it can
  438.      only be run from SL).  It will detect that you are local, and when
  439.      you go to 'U'pload the packet, it will find it.  SLQWiK will delete
  440.      it if it is successfully imported.
  441.  
  442.  
  443.      To download a packet locally, just run the door.  Your .QWK packet
  444.      will be placed in the Local .QWK directory, as defined in SLQSETUP,
  445.      when the door is finished.  It is your resonsibility to delete old
  446.      packets.  SLQWiK will not delete local QWK packets.
  447.  
  448.  
  449.    REGISTRATION
  450.  
  451.      SLQWiK is distributed as ShareWare.  There is a trial period of
  452.      forty-five days in which you may evaluate SLQWiK.  At the end of
  453.      forty-five days, if you do not register SLQWiK, then you may not
  454.      continue using it.  Please read the DISCLAIMER & SHAREWARE
  455.      AGREEMENT earlier in the documentation for more information.
  456.  
  457.      To Register SLQWiK, fill out the enclosed registration form!
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.                                   Page 8
  472.  
  473.         SLQWiK 1.00 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.    SUPPORT - BUG REPORTS
  481.  
  482.      ABS Software Development
  483.      P.O. Box 55647
  484.      Jackson, MS 39296-5647
  485.  
  486.      The Big Bang Theory BBS
  487.      SysOp: Jack Ridgway
  488.      601-366-1664
  489.      USR Dual Standard
  490.  
  491.      CIS - 70740,450
  492.      SLBBS - J RIDGWAY
  493.      GEnie - J.RIDGWAY4
  494.      SL_Net - 250:302/532
  495.      FidoNet - 1:3632/104
  496.  
  497.  
  498.    ACKNOWLEDGMENTS
  499.  
  500.      * MS-DOS is a registered trademark of Microsoft Corporation
  501.      * PKZip is a registered trademark of PKWARE Inc.
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.                                   Page 9
  531.  
  532.         SLQWiK 1.00 Copyright (c) 1991 A.B.S. - ALL RIGHTS RESERVED
  533.